Class: GOBL::Envelope

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Envelope

Includes:

GOBL::Extensions::EnvelopeHelper

Defined in:

lib/generated/gobl/envelope.rb

Overview

Envelope wraps around a document adding headers and digital signatures.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Envelope structure

'https://gobl.org/draft-0/envelope'

Instance Attribute Summary

• #$schema($schema) ⇒ String readonly

  Schema identifies the schema that should be used to understand this document.

• #doc ⇒ GOBL::Schema::Object readonly

  The data inside the envelope.

• #head ⇒ GOBL::Head::Header readonly

  Details on what the contents are.

• #sigs ⇒ Array<GOBL::DSig::Signature> readonly

  JSON Web Signatures of the header.

Method Summary

Methods included from GOBL::Extensions::EnvelopeHelper

#extract, included

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#$schema($schema) ⇒ String (readonly)

Schema identifies the schema that should be used to understand this document

Returns:

• (String)

# File 'lib/generated/gobl/envelope.rb', line 17

property :$schema, String

#doc ⇒ GOBL::Schema::Object (readonly)

The data inside the envelope

Returns:

• (GOBL::Schema::Object)

# File 'lib/generated/gobl/envelope.rb', line 29

property :doc, GOBL::Schema::Object

#head ⇒ GOBL::Head::Header (readonly)

Details on what the contents are

Returns:

• (GOBL::Head::Header)

# File 'lib/generated/gobl/envelope.rb', line 23

property :head, GOBL::Head::Header

#sigs ⇒ Array<GOBL::DSig::Signature> (readonly)

JSON Web Signatures of the header

Returns:

• (Array<GOBL::DSig::Signature>)

# File 'lib/generated/gobl/envelope.rb', line 35

property :sigs, [GOBL::DSig::Signature]